[doc] Fixathon 2: documentation sprint#22289
Merged
Merged
Conversation
siliataider
requested review from
bellenot,
couet,
dpiparo,
guitargeek,
hageboeck,
jblomer,
linev,
martamaja10,
pcanal and
vepadulano
as code owners
siliataider
added
in:Documentation
in:I/O
in:Python Interface
in:RDataFrame
in:Hist
in:ML
siliataider
force-pushed
the
fixathon_docs
branch
from
5db0a05 to
c114459
Compare
ferdymercury
suggested changes
May 14, 2026
Collaborator
ferdymercury
left a comment
ferdymercury
left a comment
There was a problem hiding this comment.
Thanks a lot for this endeavor!
Two remarks
- QHP generation shouldn't be disabled for main Doxyfile since it's used to publish qch file which is fundamental for qtcreator IDE
- it would be a lot cleaner if you used, as ALICE O2, this approach: #17426 rather than having two huge Doxyfiles almost impossible to review and annoying to maintain with warnings depending on version, etc
ferdymercury
suggested changes
May 14, 2026
siliataider
force-pushed
the
fixathon_docs
branch
from
c114459 to
b397b7e
Compare
vepadulano
requested changes
May 15, 2026
Member
vepadulano
left a comment
vepadulano
left a comment
There was a problem hiding this comment.
Thank you for all of this work! I have reviewed the Python part of the PR, here are some comments from my side.
Test Results 21 files 21 suites 3d 5h 57m 33s ⏱️ Results for commit 9b486d3. ♻️ This comment has been updated with latest results. |
vepadulano
requested changes
May 18, 2026
siliataider
force-pushed
the
fixathon_docs
branch
from
c4e18aa to
fae36de
Compare
- Move the web widgets to the webdisplay group. - Move webdisplay to GUI group. - Put the parametric functions group under Math. - Regroup I/O doxygen groups. - Move doxygen GUI group to Graphics Co-authored-by: martinfoell <m.foell.1999@gmail.com>
- Remove internal and detail classes from RDF group. - Remove source files from RDF group. - Expand docs of RDataFrame overview page. - Structure documentation of RDataFrame API.
…xygen group. Listing files on the doxygen page doesn't have a lot of benefit. Instead, we will list the contained classes.
- Enable sorting of groups in the treeview - Enable right-hand side scrolling site overview - Add "make preview" for a fast preview mode without ROOT customisations, with MT processing, and without dot graphs - Enable inlining of inherited members into the overview of class functions
siliataider
force-pushed
the
fixathon_docs
branch
from
fae36de to
9e3e5cf
Compare
siliataider
force-pushed
the
fixathon_docs
branch
from
9e3e5cf to
9b486d3
Compare
dpiparo
approved these changes
May 20, 2026
vepadulano
approved these changes
May 20, 2026
Member
vepadulano
left a comment
vepadulano
left a comment
There was a problem hiding this comment.
Thanks for addressing all the comments, LGTM!
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cleanup, refactoring, cheat sheets, etc.
Changes summary
General
\file xxx \ingroup yyy). These clutter the overview without adding useful documentation.Python Interface
RDataLoaderpage walking users through data preparation, loader configuration, batch iteration etc.UHIpage with an updated intro and a new Serialization sectionRDataLoaderandUHI) as a proof of concept (one-page PDF references downloadable and embedded directly in the docs too)Search Engine
Preview
See a preview of the doxygen page here:
https://root.cern/doc/hackathon/index.html
Note: This webpage does not contain the full doyxgen run. Macros embedded in the source code are not being run.